RELEASE-NOTES-1.25

   1 Security reminder: If you have PHP's register_globals option set, you must
   2 turn it off. MediaWiki will not work with it enabled.
   3
   4 == MediaWiki 1.25 ==
   5
   6 THIS IS NOT A RELEASE YET
   7
   8 MediaWiki 1.25 is an alpha-quality branch and is not recommended for use in
   9 production.
  10
  11 === Configuration changes in 1.25 ===
  12 * $wgPageShowWatchingUsers was removed.
  13 * $wgLocalVirtualHosts has been added to replace $wgConf->localVHosts.
  14 * $wgAntiLockFlags was removed.
  15 * $wgJavaScriptTestConfig was removed.
  16 * Edit tokens returned from User::getEditToken may change on every call. Token
  17   validity must be checked by passing the user-supplied token to
  18   User::matchEditToken rather than by testing for equality with a
  19   newly-generated token.
  20 * (T74951) The UserGetLanguageObject hook may be passed any IContextSource
  21   for its $context parameter. Formerly it was documented as receiving a
  22   RequestContext specifically.
  23 * Profiling was restructured and $wgProfiler now requires an 'output' parameter.
  24   See StartProfiler.sample for details.
  25 * $wgMangleFlashPolicy was added to make MediaWiki's mangling of anything that
  26   might be a flash policy directive configurable.
  27 * ApiOpenSearch now supports XML output. The OpenSearchXml extension should no
  28   longer be used. If extracts and page images are desired, the TextExtracts and
  29   PageImages extensions are required.
  30 * $wgOpenSearchTemplate is deprecated in favor of $wgOpenSearchTemplates.
  31 * Edits are now prepared via AJAX as users type edit summaries. This behavior
  32   can be disabled via $wgAjaxEditStash.
  33 * (T46740) The temporary option $wgIncludejQueryMigrate was removed, along
  34   with the jQuery Migrate library, as indicated when this option was provided in
  35   MediaWiki 1.24.
  36
  37 === New features in 1.25 ===
  38 * (T64861) Updated plural rules to CLDR 26. Includes incompatible changes
  39   for plural forms in Russian, Prussian, Tagalog, Manx and several languages
  40   that fall back to Russian.
  41 * (T60139) ResourceLoaderFileModule now supports language fallback
  42   for 'languageScripts'.
  43 * Added a new hook, "ContentAlterParserOutput", to allow extensions to modify the
  44   parser output for a content object before links update.
  45 * (T37785) Enhanced recent changes and extended watchlist are now default.
  46   Documentation: https://meta.wikimedia.org/wiki/Help:Enhanced_recent_changes
  47   and https://www.mediawiki.org/wiki/Manual:$wgDefaultUserOptions.
  48 * (T69341) SVG images will no longer be base64-encoded when being embedded
  49   in CSS. This results in slight size increase before gzip compression (due to
  50   percent-encoding), but up to 20% decrease after it.
  51 * Upgrade jStorage to v0.4.12.
  52 * MediaWiki now natively supports page status indicators: icons (or short text
  53   snippets) usually displayed in the top-right corner of the page. They have
  54   been in use on Wikipedia for a long time, implemented using templates and CSS
  55   absolute positioning.
  56   - Basic wikitext syntax: <indicator name="foo">[[File:Foo.svg|20px]]</indicator>
  57   - Usage instructions: https://www.mediawiki.org/wiki/Help:Page_status_indicators
  58   - Adjusting custom skins to support indicators:
  59     https://www.mediawiki.org/wiki/Manual:Skinning#Page_status_indicators
  60 * Edit tokens may now be time-limited: passing a maximum age to
  61   User::matchEditToken will reject any older tokens.
  62 * The debug logging internals have been overhauled, and are now using the
  63   PSR-3 interfaces.
  64 * Update CSSJanus to v1.1.1.
  65 * Update lessphp to v0.5.0.
  66 * Added a hook, "ApiOpenSearchSuggest", to allow extensions to provide extracts
  67   and images for ApiOpenSearch output. The semantics are identical to the
  68   "OpenSearchXml" hook provided by the OpenSearchXml extension.
  69 * PrefixSearchBackend hook now has an $offset parameter. Combined with $limit,
  70   this allows for pagination of prefix results. Extensions using this hook
  71   should implement supporting behavior. Not doing so can result in undefined
  72   behavior from API clients trying to continue through prefix results.
  73 * Update jQuery from v1.11.1 to v1.11.2.
  74
  75 ==== External libraries ====
  76 * MediaWiki now requires certain external libraries to be installed. In the past
  77   these were bundled inside the Git repository of MediaWiki core, but now they
  78   need to be installed separately. For users using the tarball, this will be taken
  79   care of and no action will be required. Users using Git will either need to use
  80   composer to fetch dependencies or use the mediawiki/vendor repository which includes
  81   all dependencies for MediaWiki core and ones used in Wikimedia deployment. Detailed
  82   instructions can be found at:
  83   https://www.mediawiki.org/wiki/Download_from_Git#Fetch_external_libraries
  84 * The following libraries are now required:
  85 ** psr/log
  86    This library provides the interfaces set by the PSR-3 standard (http://www.php-fig.org/psr/psr-3/)
  87    which are used by MediaWiki interally by the MWLogger class.
  88    See the structured logging RfC (https://www.mediawiki.org/wiki/Requests_for_comment/Structured_logging)
  89    for more background information.
  90 ** cssjanus/cssjanus
  91    This library was formerly bundled with MediaWiki core and has been removed.
  92    It automatically flips CSS for RTL support.
  93 ** leafo/lessphp
  94    This library was formerly bundled with MediaWiki core and has been removed.
  95    It compiles LESS files into CSS.
  96 ** wikimedia/cdb
  97    This library was formerly a part of MediaWiki core, and has been moved into a separate library.
  98    It provides CDB functions which are used in the Interwiki and Localization caches.
  99    More information about the library can be found at https://www.mediawiki.org/wiki/CDB.
 100
 101 === Bug fixes in 1.25 ===
 102 * (T73003) No additional code will be generated to try to load CSS-embedded
 103   SVG images in Internet Explorer 6 and 7, as they don't support them anyway.
 104 * (T69021) On Special:BookSources, corrected validation of ISBNs (both
 105   10- and 13-digit forms) containing "X".
 106 * Page moving was refactored into a MovePage class. As part of that:
 107 ** The AbortMove hook was removed.
 108 ** MovePageIsValidMove is for extensions to specify whether a page
 109    cannot be moved for technical reasons, and should not be overridden.
 110 ** MovePageCheckPermissions is for checking whether the given user is
 111    allowed to make the move.
 112 ** Title::moveNoAuth() was deprecated. Use the MovePage class instead.
 113 ** Title::moveTo() was deprecated. Use the MovePage class instead.
 114 ** Title::isValidMoveOperation() broken down into MovePage::isValidMove()
 115    and MovePage::checkPermissions().
 116 * (T18530) Multiple autocomments are now formatted in an edit summary.
 117 * (T70361) Autocomments containing "/*" are parsed correctly.
 118 * The Special:WhatLinksHere page linked from 'Number of redirects to this page'
 119   on action=info about a file page does not list file links anymore.
 120 * (T78637) Search bar is not autofocused unless it is empty so that proper scrolling using arrow keys is possible.
 121
 122 === Action API changes in 1.25 ===
 123 * (T67403) XML tag highlighting is now only performed for formats
 124   "xmlfm" and "wddxfm".
 125 * action=paraminfo supports generalized submodules (modules=query+value),
 126   querymodules and formatmodules are deprecated
 127 * action=paraminfo no longer outputs descriptions and other help text by
 128   default. If needed, it may be requested using the new 'helpformat' parameter.
 129 * action=help has been completely rewritten, and outputs help in HTML
 130   rather than plain text.
 131 * Hitting api.php without specifying an action now displays only the help for
 132   the main module, with links to submodule help.
 133 * API help is no longer displayed on errors.
 134 * 'uselang' is now a recognized API parameter; "uselang=user" may be used to
 135   explicitly select the language from the current user's preferences, and
 136   "uselang=content" may be used to select the wiki's content language.
 137 * Default output format for the API is now jsonfm.
 138 * Simplified continuation will return a "batchcomplete" property in the result
 139   when a batch of pages is complete.
 140 * Pretty-printed HTML output now has nicer formatting and (if available)
 141   better syntax highlighting.
 142 * Deprecated list=deletedrevs in favor of newly-added prop=deletedrevisions and
 143   list=alldeletedrevisions.
 144 * prop=revisions will gracefully continue when given too many revids or titles,
 145   rather than just ignoring the extras.
 146 * prop=revisions will no longer die if rvcontentformat doesn't match a
 147   revision's content model; it will instead warn and omit the content.
 148 * If the user has the 'deletedhistory' right, action=query's revids parameter
 149   will now recognize deleted revids.
 150 * prop=revisions may be used as a generator, generating revids.
 151 * (T68776) format=json results will no longer be corrupted when
 152   $wgMangleFlashPolicy is in effect. format=php results will cleanly return an
 153   error instead of returning invalid serialized data.
 154 * Generators may now return data for the generated pages when used with
 155   action=query.
 156 * Query page data for generator=search and generator=prefixsearch will now
 157   include an "index" field, which may be used by the client for sorting the
 158   search results.
 159 * ApiOpenSearch now supports XML output.
 160 * ApiOpenSearch will now output descriptions and URLs as array indexes 2 and 3
 161   in JSON format.
 162 * (T76051) list=tags will now continue correctly.
 163 * (T76052) list=tags can now indicate whether a tag is defined.
 164 * (T75522) list=prefixsearch now supports continuation
 165 * (T78737) action=expandtemplates can now return page properties.
 166 * (T78690) list=allimages now accepts multiple pipe-separated values
 167   for the 'aimime' parameter.
 168
 169 === Action API internal changes in 1.25 ===
 170 * ApiHelp has been rewritten to support i18n and paginated HTML output.
 171   Most existing modules should continue working without changes, but should do
 172   the following:
 173   * Add an i18n message "apihelp-{$moduleName}-description" to replace getDescription().
 174   * Add i18n messages "apihelp-{$moduleName}-param-{$param}" for each parameter
 175     to replace getParamDescription(). If necessary, the settings array returned
 176     by getParams() can use the new ApiBase::PARAM_HELP_MSG key to override the
 177     message.
 178   * Implement getExamplesMessages() to replace getExamples().
 179 * Modules with submodules (like action=query) must have their submodules
 180   override ApiBase::getParent() to return the correct parent object.
 181 * The 'APIGetDescription' and 'APIGetParamDescription' hooks are deprecated,
 182   and will have no effect for modules using i18n messages. Use
 183   'APIGetDescriptionMessages' and 'APIGetParamDescriptionMessages' instead.
 184 * Api formatters will no longer be asked to display the help screen on errors.
 185 * ApiMain::getCredits() was removed. The credits are available in the
 186   'api-credits' i18n message.
 187 * ApiFormatBase has been changed to support i18n and syntax highlighting via
 188   extensions with the new 'ApiFormatHighlight' hook. Core syntax highlighting
 189   has been removed.
 190 * ApiFormatBase now always buffers. Output is done when
 191   ApiFormatBase::closePrinter is called.
 192 * Much of the logic in ApiQueryRevisions has been split into ApiQueryRevisionsBase.
 193 * The 'revids' parameter supplied by ApiPageSet will now count deleted
 194   revisions as "good" if the user has the 'deletedhistory' right. New methods
 195   ApiPageSet::getLiveRevisionIDs() and ApiPageSet::getDeletedRevisionIDs() are
 196   provided to access just the live or just the deleted revids.
 197 * Added ApiPageSet::setGeneratorData() and ApiPageSet::populateGeneratorData()
 198   to allow generators to include data in the action=query result.
 199 * The following methods have been deprecated and may be removed in a future
 200   release:
 201   * ApiBase::getDescription
 202   * ApiBase::getParamDescription
 203   * ApiBase::getExamples
 204   * ApiBase::makeHelpMsg
 205   * ApiBase::makeHelpArrayToString
 206   * ApiBase::makeHelpMsgParameters
 207   * ApiFormatBase::setUnescapeAmps
 208   * ApiFormatBase::getWantsHelp
 209   * ApiFormatBase::setHelp
 210   * ApiFormatBase::formatHTML
 211   * ApiFormatBase::setBufferResult
 212   * ApiFormatBase::getDescription
 213   * ApiMain::setHelp
 214   * ApiMain::reallyMakeHelpMsg
 215   * ApiMain::makeHelpMsgHeader
 216   * ApiQueryImageInfo::getPropertyDescriptions
 217 * The following classes have been deprecated and may be removed in a future
 218   release:
 219   * ApiQueryDeletedrevs
 220
 221 === Languages updated in 1.25 ===
 222
 223 MediaWiki supports over 350 languages. Many localisations are updated
 224 regularly. Below only new and removed languages are listed, as well as
 225 changes to languages because of Bugzilla reports.
 226
 227 * (T66440) Kazakh (kk) wikis should no longer forcefully reset the user's
 228   interface language to kk where unexpected.
 229
 230 === Other changes in 1.25 ===
 231 * The skin autodiscovery mechanism, deprecated in MediaWiki 1.23, has been
 232   removed. See https://www.mediawiki.org/wiki/Manual:Skin_autodiscovery for
 233   migration guide for creators and users of custom skins that relied on it.
 234 * Javascript variable 'wgFileCanRotate' and 'wgFileExtensions' now only
 235   available on Special:Upload.
 236 * (T58257) Set site logo from mediawiki.skinning.interface module instead of
 237   inline styles in the HTML.
 238 * Removed ApiQueryUsers::getAutoGroups(). (deprecated since 1.20)
 239 * Removed XmlDumpWriter::schemaVersion(). (deprecated since 1.20)
 240 * Removed LogEventsList::getDisplayTitle(). (deprecated since 1.20)
 241 * Removed Preferences::trySetUserEmail(). (deprecated since 1.20)
 242 * Removed mw.user.name() and mw.user.anonymous() methods. (deprecated since 1.20)
 243 * Removed 'ok' and 'err' parameters in the mediawiki.api modules. (deprecated
 244   since 1.20)
 245 * Removed 'async' parameter from the  mw.Api#getCategories() method. (deprecated
 246   since 1.20)
 247 * Removed 'jquery.json' module. (deprecated since 1.24)
 248   Use the 'json' module and global JSON object instead.
 249 * Deprecated OutputPage::readOnlyPage() and OutputPage::rateLimited().
 250   Also, the former will now throw an MWException if called with one or more
 251   arguments.
 252 * Removed hitcounters and associated code.
 253 * The "temp" zone of the upload respository is now considered private. If it
 254   already exists (such as under the images/ directory), please make sure that
 255   the directory is not web readable (e.g. via a .htaccess file).
 256 * BREAKING CHANGE: In the XML dump format used by Special:Export and
 257   dumpBackup.php, the <model> and <format> tags now apprear before the <text>
 258   tag, instead of after the <text> and <sha1> tags.
 259   The new schema version is 0.10, the new schema URI is:
 260   https://www.mediawiki.org/xml/export-0.10.xsd
 261 * MWFunction::call() and MWFunction::callArray() were removed, having being
 262   deprecated in 1.22.
 263 * Deprecated the getInternalLinkAttributes, getInternalLinkAttributesObj,
 264   and getInternalLinkAttributes methods in Linker, and removed
 265   getExternalLinkAttributes method, which was deprecated in MediaWiki 1.18.
 266 * Removed Sites class, which was deprecated in 1.21 and replaced by SiteSQLStore.
 267 * The mw.api.getToken() method now uses action=query?meta=tokens. This will now
 268   fail for custom tokens registered only via the deprecated ApiTokensGetTokenTypes
 269   hook. The ApiQueryTokensRegisterTypes hook should be used for this to work.
 270 * Added wgRelevantArticleId to the client-side config, for use on special pages.
 271 * Deprecated the TitleIsCssOrJsPage hook. Superseded by the
 272   ContentHandlerDefaultModelFor hook since MediaWiki 1.21.
 273 * Deprecated the TitleIsWikitextPage hook. Superseded by the
 274   ContentHandlerDefaultModelFor hook since MediaWiki 1.21.
 275 * Changed parsing of variables in schema (.sql) files:
 276 ** The substituted values are no longer parsed. (Formerly, several passes
 277    were made for each variable, so depending on the order in which variables
 278    were defined, variables might have been found inside encoded values. This
 279    is no longer the case.)
 280 ** Variables are no longer string encoded when the /*$var*/ syntax is used.
 281    If string encoding is necessary, use the '{$var}' syntax instead.
 282 ** Variable names must only consist of one or more of the characters
 283    "A-Za-z0-9_".
 284 ** In source text of the form '{$A}'{$B}' or `{$A}`{$B}`, where variable A
 285    does not exist yet variable B does, the latter may not be replaced.
 286    However, this difference is unlikely to arise in practice.
 287 * (T67278) RFC, PMID, and ISBN "magic links" must be surrounded by non-word
 288   characters on both sides.
 289 * The FormatAutocomments hook will now receive $pre and $post as booleans,
 290   rather than as strings that must be prepended or appended to $comment.
 291 * (T30950, T31025) RFC, PMID, and ISBN "magic links" can no longer contain
 292   newlines; but they can contain &nbsp; and other non-newline whitespace.
 293
 294 == Compatibility ==
 295
 296 MediaWiki 1.25 requires PHP 5.3.3 or later. There is experimental support for
 297 HHVM 3.3.0.
 298
 299 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
 300 support for them is somewhat less mature. There is experimental support for
 301 Oracle and Microsoft SQL Server.
 302
 303 The supported versions are:
 304
 305 * MySQL 5.0.2 or later
 306 * PostgreSQL 8.3 or later
 307 * SQLite 3.3.7 or later
 308 * Oracle 9.0.1 or later
 309 * Microsoft SQL Server 2005 (9.00.1399)
 310
 311 == Upgrading ==
 312
 313 1.25 has several database changes since 1.24, and will not work without schema
 314 updates. Note that due to changes to some very large tables like the revision
 315 table, the schema update may take quite long (minutes on a medium sized site,
 316 many hours on a large site).
 317
 318 If upgrading from before 1.11, and you are using a wiki as a commons
 319 repository, make sure that it is updated as well. Otherwise, errors may arise
 320 due to database schema changes.
 321
 322 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
 323 new database fields are filled with data.
 324
 325 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
 326 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
 327 with MediaWiki 1.21.
 328
 329 Don't forget to always back up your database before upgrading!
 330
 331 See the file UPGRADE for more detailed upgrade instructions.
 332
 333 For notes on 1.24.x and older releases, see HISTORY.
 334
 335 == Online documentation ==
 336
 337 Documentation for both end-users and site administrators is available on
 338 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 339 for pages that explicitly state that their contents are in the public domain):
 340
 341         https://www.mediawiki.org/wiki/Documentation
 342
 343 == Mailing list ==
 344
 345 A mailing list is available for MediaWiki user support and discussion:
 346
 347         https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
 348
 349 A low-traffic announcements-only list is also available:
 350
 351         https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
 352
 353 It's highly recommended that you sign up for one of these lists if you're
 354 going to run a public MediaWiki, so you can be notified of security fixes.
 355
 356 == IRC help ==
 357
 358 There's usually someone online in #mediawiki on irc.freenode.net.